﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

#pragma once
#include "IMepObject.h"

namespace gap
{
    class IExtraDataComponent;
}

namespace gcmp 
{
    class IElement;
    class ElementId;
    class UniIdentity;
    class IDocument;
    class IGraphicsElementShape;
}

namespace gmep
{
    ///brief:机电元素基类
    class GMEP_MODEL_BASE_INTERFACE_EXPORT IMepElement : public IMepObject
    {
        DEFINE_CAST_DERIVED(gmep::IMepElement, gmep::IMepObject);
    public:
        virtual ~IMepElement() {}

    public:
        /// \brief 得到gcmp平台的元素指针
        /// \return gcmp平台的元素指针
        virtual const gcmp::IElement *GetElement() const = 0;

        /// \brief 得到gcmp平台的元素指针
        /// \return gcmp平台的元素指针
        virtual gcmp::IElement* GetElement() = 0;

        /// \brief 得到元素Id
        /// \return 元素Id
        gcmp::ElementId GetElementId() const;

        /// \brief 得到对象所在的文档指针
        /// \return 文档指针
        gcmp::IDocument *GetDocument() const;

        /// \brief 得到对象所在的文档指针
        /// \return 文档指针
        gcmp::IDocument* GetDocument();


        /// \brief 设置机电元素名称
        /// \param name 名称
        /// \return 返回true表示设置成功，否则表示失败
        virtual bool SetName(const std::wstring& name);

        /// \brief 得到元素名称
        /// \return 元素名称
        virtual std::wstring GetName() const;

        /// \brief 获得元素所属类别的Uid
        /// \return const UniIdentity& 元素所属类别的Uid
        const gcmp::UniIdentity& GetCategoryUid() const;

        /// \brief 获得元素是否是临时元素
        /// \return bool 返回true表示是临时元素，false为非临时元素。
        virtual bool IsTransient() const;

        /// \brief 得到元素对象图形表达
        /// \return 元素对象图形表达。返回nullptr表示不含图形
        const gcmp::IGraphicsElementShape* GetGraphicsElementShape() const;

        /// \brief 更新当前Element
        /// 
        /// 更新完成后，此Element的数据都处于最新状态
        /// \see IRegenerator的RegenerateElement函数
        /// \return 成功返回true，失败返回false
        bool Regenerate();

        /// \brief 获取扩展数据组件管理器
        /// \return 扩展数据组件管理器
        virtual gap::IExtraDataComponent* GetExtraDataComponent() = 0;
        /// \brief 获取扩展数据组件管理器
        /// \return 扩展数据组件管理器
        virtual const gap::IExtraDataComponent* GetExtraDataComponent() const = 0;
        /// \brief 注册扩展数据组件
        /// \return 成功返回true，失败返回false
        virtual bool RegistExtraDataComponent() = 0;
    };
}
